home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 016a / 4log05.zip / 4LOG.REF < prev    next >
Text File  |  1991-05-22  |  16KB  |  393 lines
  1.  
  2.  
  3.                   ____________________________________________
  4.                  |                                            |
  5.                  |        4 L O G  -  4DOS LOG ANALYSIS       |
  6.                  |        -----------------------------       |
  7.                  |              Version 0.5 (Beta)            |
  8.                  |                 May 22, 1991               |
  9.                  |____________________________________________|
  10.  
  11.                       ====================================
  12.                       Parameter Descriptions and Reference
  13.                       ====================================
  14.  
  15.                       Copyright (c) 1991 by Mike St. Clair
  16.                                All Rights Reserved
  17.  
  18.  
  19.         This file contains information specifying 4LOG Parameters.
  20.  
  21.         Following are  definitions of  the 4LOG  configuration parameters
  22.         and  options.   Upper  and  lower  case  are not  significant  in
  23.         specifying  parameters.   The  parameter  name  may  be  followed
  24.         directly by the parameter  value or they  may be separated by  an
  25.         "=" depending  on the  users preference.   You may  use whichever
  26.         format you are most comfortable with or randomly mix them.  Those
  27.         parameters which  do not use  a value  may be specified  alone or
  28.         followed by "=Y" to be turned on.  Turn them off by following the
  29.         parameter with "=N"
  30.  
  31.         Parameters  can  be  specified  on  the   command  line,  in  the
  32.         configuration file 4LOG.CFG or in the DOS environment  by setting
  33.         variable 4LOG.   Parameters from the command line  override those
  34.         from 4LOG.CFG and from the  DOS environment variable 4LOG.  Those
  35.         in the 4LOG.CFG file override those from the DOS environment.
  36.  
  37.         When these parameters are entered in the 4LOG.CFG file,  comments
  38.         can be  included.  Any string starting with "  -" or " /" will be
  39.         interpreted  as  a configuration  parameter.    The rest  of  the
  40.         contents will be assumed to be comments.  You can use the program
  41.         4LOGCFG (not included  in this BETA version) to  create or modify
  42.         4LOG.CFG or  you may use an ASCII text  editor.  Any leading path
  43.         name included  in the 4DOS  log is automatically stripped  so the
  44.         actual command name can be properly analyzed and summarized.
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.         May 22, 1991    4LOG.REF (Parameter Descriptions)     Page 1 of 7
  57.  
  58.  
  59.         =================================
  60.         Current Configuration Parameters:
  61.         =================================
  62.  
  63.         =================================================================
  64.         AS   Array Size:
  65.  
  66.              Example: -AS=500   (allow for up to 500 unique commands)
  67.              Default: -AS=200   if AS is not used or is used with no size
  68.  
  69.              AS allows for this many unique commands to be summarized. If
  70.              not  enough space is allocated, commands  beyond the AS size
  71.              are discarded with the number of discards counted.
  72.         =================================================================
  73.         BD   Begin Date:
  74.  
  75.              Example: -BD=04/01/91   (start processing data 4/1/91)
  76.              Default: -BD=01/01/00   if BD is not used or is used without
  77.                       a date
  78.  
  79.              4LOG ignores any data from before the date specified by BD.
  80.         =================================================================
  81.         BM   Batch Mode:
  82.  
  83.              Example: -BM (run in the batch mode)
  84.              Default: use interactive mode
  85.  
  86.              When running in batch mode, 4LOG will not ask for any input
  87.              at run time.
  88.         =================================================================
  89.         CF   Configuration File:
  90.  
  91.              Example: -SI=C:\4log.cfg (get configuration from this file)
  92.              Default: 4dos.cfg  in current directory if CF is not used or
  93.                       if CF is used without a path name.
  94.  
  95.              Note that the  CF parameter cannot come from  within the CFG
  96.              file  but must  be specified  in the  environment or  on the
  97.              command line.
  98.         =================================================================
  99.         DC Display Count:
  100.  
  101.              Example: -DC=10 (show commands with count of > 10 on screen)
  102.              Default: -DC=5  (show commands with count of >  5 on screen)
  103.  
  104.              During  4LOG processing, command counts are displayed on the
  105.              screen when they reach this  number. If too many commands to
  106.              fit on the screen are  exceed this count, 4LOG will increase
  107.              this  number  dynamically whenever  required. Note  that the
  108.              summary  file and optional printed report both include those
  109.              commands which will not fit on the screen.
  110.         =================================================================
  111.  
  112.         May 22, 1991    4LOG.REF (Parameter Descriptions)     Page 2 of 7
  113.  
  114.  
  115.         =================================================================
  116.         ED End Date:
  117.  
  118.              Example: -ED=04/30/91 (stop processing after 4/30/91)
  119.              Default: -ED=12/31/99 if ED is not used or ED is used but no
  120.                       date is given.
  121.  
  122.              4LOG ignores any data from after the date specified by ED.
  123.         =================================================================
  124.         LI   Internal Command Exclude list:
  125.  
  126.              Example: -LI=C:\4LOG\4LOGICMD.LST   (exclude  command  names
  127.                       listed in this file)
  128.              Default: 4LOGICOM.LST  in  the  current  path  if LI is used
  129.                       without  a  path  or  if ZI  is  used  without  LI.
  130.                       Internal  commands are not  excluded if  neither LI
  131.                       nor ZI is specified.
  132.  
  133.              Command names contained in this list will be ignored and not
  134.              included in any analysis. It  actually works just like LX. A
  135.              file  with  the  default  name  containing  a  list of  4DOS
  136.              internal commands  is distributed  with 4LOG.  The user  may
  137.              freely  modify  this list.    It  contains  entries  in  the
  138.              following format with the command starting in column 1:
  139.                CDD       /* CDD an internal command to be excluded */
  140.              Lines beginning with "*" or blank will be skipped.
  141.         =================================================================
  142.         LX   Exclude Command List:
  143.  
  144.              Example: -LX=C:\4LOG\4LOGEXCL.LST   (exclude commands listed
  145.                       in this file)
  146.              Default: 4LOGEXCL.LST  in  the  current  path, if LX is used
  147.                       without a path.  No exclusions if LX is not used.
  148.  
  149.              Command names contained in this list will be ignored and
  150.              not included in any analysis.  List contains entries in the
  151.              following format with the command starting in column 1:
  152.                OPTUNE     /* exclude the command OPTUNE  */
  153.                OPTUNE.EXE /* exclude the command OPTUNE.EXE */
  154.              Lines beginning with "*" or blank will be skipped.
  155.         =================================================================
  156.         MI   Main LOG Input File
  157.  
  158.              Example: -MI=C:\4DOSLOG (get 4DOS LOG data from this file)
  159.              Default: 4DOSLOG in the current directory
  160.  
  161.              Specifies the name of the 4DOS log to be analyzed.
  162.         =================================================================
  163.  
  164.  
  165.  
  166.  
  167.  
  168.         May 22, 1991    4LOG.REF (Parameter Descriptions)     Page 3 of 7
  169.  
  170.  
  171.         =================================================================
  172.         ML   Message Level: (0 = minimal messages, 9 = all messages)
  173.  
  174.              Example: -ML=0 (suppress most messages)
  175.              Default: -ML=9 if ML is not used
  176.  
  177.              Allows   suppression   of    most screen  output  to   speed
  178.              processing and  for batch  mode operation  where the  screen
  179.              display is not needed.
  180.         =================================================================
  181.         PR   Print Summary Report:
  182.  
  183.              Example: -PR (print a report showing commands executed)
  184.              Default: Do not print a summary report. Just list to screen.
  185.  
  186.              Parameter determines whether the command summary is printed.
  187.         =================================================================
  188.         ZD   Ignore Default Disk Switches:
  189.  
  190.              Example: -ZD (ignore disk drive switches e.g. c:)
  191.              Default: Summarize  the  disk  switch commands just like all
  192.                       other commands.
  193.  
  194.              If this switch is not set, disk switches will show up in the
  195.              analysis as  C:, D:,  etc. Specifying ZL  as greater  than 2
  196.              will also suppress disk switch commands.
  197.         =================================================================
  198.         ZI   Suppress Processing of Internal 4DOS Commands:
  199.  
  200.              Example: -ZI (suppress internal commands from IL file)
  201.              Default: process internal commands like any other
  202.  
  203.              See the IL  parameter for the file name  containing the list
  204.              of suppressed 4DOS internal commands.  This list is included
  205.              in the distribution archive file  but can be modified by the
  206.              user as desired.
  207.         =================================================================
  208.         ZL   Suppress Commands Shorter than the Specified Length:
  209.  
  210.              Example: -ZL=3 (ignore commands of length 3 or shorter)
  211.              Default: -ZL=1 if  ZL  is  not  used, commands of length one
  212.                       will be suppressed.
  213.  
  214.              Requests  that 4LOG  ignore any  commands  of the  specified
  215.              length or less when analyzing the input log.
  216.         =================================================================
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.         May 22, 1991    4LOG.REF (Parameter Descriptions)     Page 4 of 7
  225.  
  226.  
  227.         =================================================================
  228.         ZS   Suppress Suffixes on Commands
  229.  
  230.              Example: -ZS (drop the extension from all command names)
  231.              Default: do not drop suffixes
  232.  
  233.              If this parameter is given, the period and extension will be
  234.              dropped  from   any  command   found  in   the  log   before
  235.              summarization.   Therefore  LIST.COM,  LIST.BAT or  LIST.BTM
  236.              would all appear as LIST.
  237.         =================================================================
  238.         Z*   Suppress Leading "*" on Commands:
  239.  
  240.              Example: -Z* (drop all leading "*"s)
  241.              Default: Do not drop leading "*"s.
  242.  
  243.              Allows dropping the  leading * used by 4DOS  to bypass alias
  244.              lookup.  This would  cause  the  command  to  be  summarized
  245.              together with the same name without the "*".
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.  
  272.  
  273.  
  274.  
  275.  
  276.  
  277.  
  278.  
  279.  
  280.         May 22, 1991    4LOG.REF (Parameter Descriptions)     Page 5 of 7
  281.  
  282.  
  283.         ===============================
  284.         Future Configuration Parameters
  285.         ===============================
  286.  
  287.         The following options are planned but not fully implemented.
  288.  
  289.         =================================================================
  290.         HI   History Summary LOG Input File:
  291.  
  292.              Example: -HI=C:\4DOSLOG.SUM
  293.              Default: 4DOSLOG.SUM  in  current  directory  if  HI is used
  294.                       without  a path  name.  No summary  file if  HI not
  295.                       used.
  296.  
  297.              Specifies the  name of  the 4LOG summary  log to  be updated
  298.              from the data in the 4DOS LOG input file. When summary files
  299.              are  processed, this  file is first  renamed with  an ".OLD"
  300.              extension after deleting any conflicting file name.
  301.         =================================================================
  302.         HO   History Summary LOG Output File:
  303.  
  304.              Example: -HO=C:\4DOSLOG.SUM
  305.              Default: 4DOSLOG.SUM  in  current  directory  if  HO is used
  306.                       without a path name. No  summary file is created if
  307.                       HO not used.
  308.  
  309.              Specifies the  name of  the 4LOG summary  log to  be updated
  310.              from the data in the 4DOS LOG input file.
  311.         =================================================================
  312.         HR   Revise the data in the input History Summary LOG file:
  313.  
  314.              Example: -HR
  315.              Default: don't revise the history data
  316.  
  317.              If  this  parameter is  used,  4LOG will  apply  the current
  318.              parameters to revise the input history data (e.g. drop short
  319.              commands,  exclude additional commands)  If it is  not used,
  320.              new data will  be added based on the  current parameters but
  321.              the old data will be carried forward without change with the
  322.              exception of  applying a  higher level  of summarization  if
  323.              this has been requested by SL.
  324.         =================================================================
  325.         LT   Translate List
  326.  
  327.              Example: -LT=C:\4LOG\4LOGXLAT.LST
  328.              Default: 4LOGXLAT.LST  in current path if LT is used with no
  329.                       path.
  330.  
  331.              Command names contained in this list will be translated to a
  332.              new name. List contains entries in the following format:
  333.               OPT=OPTUNE /* OPT commands will summarize as OPTUNE */
  334.         =================================================================
  335.  
  336.         May 22, 1991    4LOG.REF (Parameter Descriptions)     Page 6 of 7
  337.  
  338.  
  339.         =================================================================
  340.         MF   Message File
  341.  
  342.              Example: -MF=C:\4LOG\SPAN.MSG (get messages from this file)
  343.              Default: -MF=C:\4LOG\4LOG.MSG if MF is not used
  344.  
  345.              Identifies a file containing the text of the messages and
  346.              screen  labels used.   The 4LOG.MSG  file included  with the
  347.              distribution  package has the  messages using  English text.
  348.              This file can be edited by any ASCII text editor or  you can
  349.              make   your   own   replacement    with   foreign   language
  350.              translations.  Note  that  the messages  and  screen  labels
  351.              cannot be expanded in size.  If they are expanded, only that
  352.              portion which is not longer  than the original entry will be
  353.              displayed.
  354.         =================================================================
  355.         SL   Summary  Level (where  x  is  D=daily, W=weekly,  M=monthly,
  356.              Q=quarterly, Y=yearly)
  357.  
  358.              Example: -SL=W
  359.              Default: no summary produced if SL is not specified
  360.  
  361.              Allows  specifying the level of summarization desired in the
  362.              summary log files. Note that if the input summary file has a
  363.              higher level of  summarization than the level  requested, no
  364.              data  will be  copied from  it.  (e.g. input  = monthly  and
  365.              output = daily)
  366.         =================================================================
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.         May 22, 1991    4LOG.REF (Parameter Descriptions)     Page 7 of 7
  393.